Skip to main content
Version: current

Sessions - Create a session​

This API creates a session within a webinar/meeting

Path Parameters
    meetingId string required

    The meeting ID for which to create a session

    Example: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
Header Parameters
    Authorization string required

    You need an app created on the JioEvents Platform and using the app credentials you can create a JWT to access this API. The JWT should have an issuer and the key "app" with the app id generated from the Platform.

    Example: <Authentication_token_signed_using_secret_or_private_key>
    Content-Type string

    The content type should be application/json

    Example: application/json
Request Body
    description string

    Description of the session

    descriptionMarkdown object

    Markdown description configuration

    text string

    Markdown text content

    messageType string

    Type of message

    invites object[]

    Array of session invites

    topic string

    Topic/title of the session

    startTime date-time

    Start time of the session in ISO format

    endTime date-time

    End time of the session in ISO format

Responses

Success

Schema
    status string

    Status message indicating the result of session creation

    sessionDetails object

    Detailed information about the created session

    _id string

    Unique identifier for the session

    topic string

    Topic/title of the session

    description string

    Description of the session

    descriptionMarkdown object

    Markdown description configuration

    text string

    Markdown text content

    messageType string

    Type of message

    meetingId string

    Unique meeting ID for the session

    parentMeetingId string

    ID of the parent webinar/meeting

    type string

    Type of session

    startTime date-time

    Start time of the session in ISO format

    endTime date-time

    End time of the session in ISO format

    invites object[]

    Array of session invites

    status string

    Current status of the session

    isDeleted boolean

    Whether the session has been deleted

    cOn date-time

    Creation timestamp

    mOn date-time

    Last modification timestamp

    __v integer

    Version number

    scheduledDuration integer

    Duration of the session in milliseconds

    meetingUrl string

    URL for joining the session

    userId string

    ID of the user who created the session

    jiomeetId string

    10-digit unique ID for the session

    pin string

    PIN for joining the session

    advancedOptions object

    Advanced configuration options for the session

    hostAudio boolean

    Whether host audio is enabled

    participantAudio boolean

    Whether participant audio is enabled

    hostVideo boolean

    Whether host video is enabled

    participantVideo boolean

    Whether participant video is enabled

    joinBeforeHost boolean

    Whether participants can join before the host

    waitingRoom boolean

    Whether waiting room is enabled

    loggedInOnly boolean

    Whether only logged-in users can join

    colleagueOnly boolean

    Whether only colleagues can join

    participantHardAudioMute boolean

    Whether participants are hard muted for audio

    participantHardVideoMute boolean

    Whether participants are hard muted for video

    isRestrictedMeeting boolean

    Whether the meeting is restricted

    isClassroomMode boolean

    Whether classroom mode is enabled

    restrictChat string

    Chat restriction level

Loading...